Skip to content

Add tutorial section#232

Merged
jaykim1213 merged 22 commits into
2.4.3from
jay/tutorial
Jun 9, 2026
Merged

Add tutorial section#232
jaykim1213 merged 22 commits into
2.4.3from
jay/tutorial

Conversation

@jaykim1213

@jaykim1213 jaykim1213 commented May 7, 2026

Copy link
Copy Markdown
Contributor

Does this PR close any open issues?

Closes #230

Give a longer description of what this PR addresses and why it's needed

  • Add tutorial section (installation, config.json, replication-config.json pages)

Live links

https://revisit.dev/PR232/docs/tutorial/
https://revisit.dev/PR232/docs/tutorial/config.json/
https://revisit.dev/PR232/docs/tutorial/replication-config.json/
https://revisit.dev/PR232/docs/getting-started/installation/

Provide pictures/videos of the behavior before and after these changes (optional)

Screenshot 2026-05-07 at 8 54 10 AM Screenshot 2026-05-07 at 8 54 21 AM Screenshot 2026-05-07 at 8 54 25 AM

jaykim1213 and others added 6 commits May 6, 2026 23:41
Bumps the npm_and_yarn group with 1 update in the / directory: [fast-uri](https://github.com/fastify/fast-uri).


Updates `fast-uri` from 3.1.0 to 3.1.2
- [Release notes](https://github.com/fastify/fast-uri/releases)
- [Commits](fastify/fast-uri@v3.1.0...v3.1.2)

---
updated-dependencies:
- dependency-name: fast-uri
  dependency-version: 3.1.2
  dependency-type: indirect
  dependency-group: npm_and_yarn
...

Signed-off-by: dependabot[bot] <support@github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new tutorial section to the documentation site for installation, config.json, and replication-config.json, with sidebar navigation and supporting tutorial walkthrough content.

Changes:

  • Adds new tutorial docs and screenshots for core study configuration workflows.
  • Expands installation guidance with prerequisite tooling and cloning steps.
  • Updates sidebar navigation and conditionally enables gtag analytics.

Reviewed changes

Copilot reviewed 7 out of 27 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
sidebars.ts Adds the Tutorial category under Getting Started.
docusaurus.config.ts Gates gtag configuration behind ENABLE_GTAG.
docs/tutorial/tutorial.md Adds tutorial landing page with embedded video and doc cards.
docs/tutorial/config.json.md Adds step-by-step tutorial for building a study config.
docs/tutorial/replication-config.json.md Adds replication study config tutorial.
docs/getting-started/installation.md Expands setup prerequisites and cloning instructions.
.github/workflows/deploy.yml Removes the existing GitHub Pages deployment workflow.
Comments suppressed due to low confidence (1)

.github/workflows/deploy.yml:1

  • Removing the only workflow that builds and publishes ./build to GitHub Pages means pushes to main will no longer deploy the documentation site. If deployment is still expected for this repo, keep this workflow or replace it with an equivalent Pages deployment workflow in the same change.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/tutorial/config.json.md
Comment thread docs/tutorial/config.json.md Outdated
Comment thread docusaurus.config.ts
@jaykim1213 jaykim1213 marked this pull request as ready for review May 19, 2026 07:27
@jaykim1213 jaykim1213 requested a review from alexsb May 21, 2026 15:12
@github-actions

github-actions Bot commented May 21, 2026

Copy link
Copy Markdown

A preview of a3e35a2 is uploaded and can be seen here:

https://revisit.dev/PR232

Changes may take a few minutes to propagate.

@jaykim1213 jaykim1213 mentioned this pull request May 23, 2026
@jaykim1213 jaykim1213 changed the base branch from main to 2.4.3 May 23, 2026 20:38
@jaykim1213 jaykim1213 removed the request for review from alexsb May 28, 2026 17:03
@codementum codementum self-requested a review May 29, 2026 15:56

@codementum codementum left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good overall to me!

A few thoughts:

  • We could test this out by running through it a few times to see if there are places where people get stuck, e.g. Windows installs for git and node can be tricky.
  • Videos running through the whole thing might be nice / helpful, but a later issue.
  • Trimming later? Currently we go through several questionnaires and demographics pages before getting to the main stimuli. We might consider swapping this so people get a stimuli or two in and then build the markdown pages. The flow right now is logical, but the idea would be to give people fun milestones.

Comment thread docs/tutorial/config.json.md Outdated
jaykim1213 and others added 7 commits May 29, 2026 15:01
Co-authored-by: Lane Harrison <ltharrison@wpi.edu>
…npm_and_yarn-053c9c4054

Bump fast-uri from 3.1.0 to 3.1.2 in the npm_and_yarn group across 1 directory
Bumps the npm_and_yarn group with 2 updates in the / directory: [@babel/plugin-transform-modules-systemjs](https://github.com/babel/babel/tree/HEAD/packages/babel-plugin-transform-modules-systemjs) and [webpack-dev-server](https://github.com/webpack/webpack-dev-server).


Updates `@babel/plugin-transform-modules-systemjs` from 7.27.1 to 7.29.7
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.29.7/packages/babel-plugin-transform-modules-systemjs)

Updates `webpack-dev-server` from 5.2.2 to 5.2.4
- [Release notes](https://github.com/webpack/webpack-dev-server/releases)
- [Changelog](https://github.com/webpack/webpack-dev-server/blob/main/CHANGELOG.md)
- [Commits](webpack/webpack-dev-server@v5.2.2...v5.2.4)

---
updated-dependencies:
- dependency-name: "@babel/plugin-transform-modules-systemjs"
  dependency-version: 7.29.7
  dependency-type: indirect
  dependency-group: npm_and_yarn
- dependency-name: webpack-dev-server
  dependency-version: 5.2.4
  dependency-type: indirect
  dependency-group: npm_and_yarn
...

Signed-off-by: dependabot[bot] <support@github.com>
…npm_and_yarn-b38d0270a8

Bump the npm_and_yarn group across 1 directory with 2 updates
@jaykim1213 jaykim1213 merged commit e580ed7 into 2.4.3 Jun 9, 2026
2 of 3 checks passed
@jaykim1213 jaykim1213 deleted the jay/tutorial branch June 9, 2026 01:09
@jaykim1213 jaykim1213 restored the jay/tutorial branch June 9, 2026 01:12
@jaykim1213 jaykim1213 deleted the jay/tutorial branch June 9, 2026 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add tutorial docs

5 participants